Skip to content

Conversation

@AliceHarang
Copy link
Collaborator

@AliceHarang AliceHarang commented Feb 21, 2023

From Documentation branch when it began:

Create a documentation for the code

We have chosen to used doxygen directly to create the documentation. An other solution would be to use doxygen associated to phynx, using some "intermediate" tools.

  • Include the images
  • Fix the latex formula
  • Add a biblio section
  • Add a tutorial / example section
  • Add a proper description of the code in first-page
  • Adjust the readme to link toward the doc
  • Add version control on the doxygen doc or/and adjust old doc
  • Update badge (codacy and remove the build from Travis?)

Create some tutorial / example (basic/jupyter - python/Julia):

  • CEA2008
  • Aureli2020 (either CEA or Aureli)
  • How to setup river flood model
  • How to setup tsunami model
  • Understand and visualise BG_Flood outputs
  • Infiltration on Orowaiti

Code documentation:

  • Complete some documentation of the code (using AI tool in github)

@AliceHarang AliceHarang changed the base branch from documentation to development September 22, 2025 01:38
@AliceHarang
Copy link
Collaborator Author

Merge directly from Documnetation 2, issue from Documnetation to development. I initially aimed to merge back to Documnetation before merging in development but the documentation branch was "broken" making the merge difficult and loosing some git information in the process....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants